Skip to content

chore: Add documentation for NetworkPrefab InstantiateWithData #3574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: develop-2.0.0
Choose a base branch
from

Conversation

EmandM
Copy link
Collaborator

@EmandM EmandM commented Aug 1, 2025

Documentation for #3497

Changelog

  • Added: Documentation for the Network prefab handler.
  • Fixed: Updated the Object spawning documentation page to be DA compatible.

Documentation

  • Includes documentation for previously-undocumented public API entry points.
  • Includes edits to existing public API documentation.

Testing & QA

Functional Testing

Manual testing :

  • Manual testing done

Automated tests:

  • Covered by existing automated tests
  • Covered by new automated tests

Does the change require QA team to:

  • Review automated tests?
  • Execute manual tests?

If any boxes above are checked, please add QA as a PR reviewer.

Backport

This is 2.x only documentation update and doesn't need a backport.

@EmandM EmandM requested a review from jabbacakes as a code owner August 1, 2025 22:00
@EmandM EmandM requested a review from a team as a code owner August 1, 2025 22:01
@michalChrobot
Copy link
Collaborator

On thing is that I should have a PR today that will allow a PR to pass without tests running if it contains ONLY documentation changes (as should be the case with this PR).

Another thing is that I wonder if instead of Added, Fixed we should introduce new category Doocumentation that would gather such changes? Asking since maybe current approach can be a bit confusing

@EmandM
Copy link
Collaborator Author

EmandM commented Aug 4, 2025

I think I like Added and Fixed in this context, it shows what files were changed. Not having to run all the Yamato checks would be magical!

@michalChrobot
Copy link
Collaborator

I should resolve the DOCS thingy together with PR template in #3577, but now I think that those should be separate PRs for more clarity. Will close this one and open 2

@michalChrobot
Copy link
Collaborator

@NoelStephensUnity @EmandM I have #3580 that will optimize our CI workflows + allow us to avoid it when changes are only in Documentation~ folder

…updates (#3579)

Some suggested updates to the network prefab handler documentation (#3574).
Some additional adjustments and additions.
Removing white spaces at the end of a line.
Fixed some spelling and text related issues.
Copy link
Collaborator

@NoelStephensUnity NoelStephensUnity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jabbacakes
Looks good to me from a content perspective, but we will wait for your approval (and any adjustments you might make) before merging.

Copy link
Contributor

@jabbacakes jabbacakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed a commit with general grammar/style/wording updates. No major notes 👍

@michalChrobot
Copy link
Collaborator

Great, @NoelStephensUnity should we merge it then so everything will be included for the release next week?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants